/*
 * Copyright (c) 2019-2029, Dreamlu 卢春梦 (596392912@qq.com & www.dreamlu.net).
 * <p>
 * Licensed under the GNU LESSER GENERAL PUBLIC LICENSE 3.0;
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * <p>
 * http://www.gnu.org/licenses/lgpl.html
 * <p>
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.pig4cloud.pig.common.xss.core;

import com.pig4cloud.pig.common.xss.utils.XssUtil;
import org.jsoup.Jsoup;

/**
 * XSS清理器接口
 * <p>
 * 定义XSS内容清理的标准接口，提供HTML内容的清理和验证功能
 * </p>
 *
 * @author L.cm
 */
public interface XssCleaner {

	/**
	 * 清理HTML内容
	 * <p>
	 * 使用默认的表单类型清理模式
	 * </p>
	 * @param html 待清理的HTML内容
	 * @return 清理后的安全HTML内容
	 */
	default String clean(String html) {
		return clean(html, XssType.FORM);
	}

	/**
	 * 清理HTML内容
	 * <p>
	 * 根据指定的XSS类型进行清理
	 * </p>
	 * @param html 待清理的HTML内容
	 * @param type XSS清理类型
	 * @return 清理后的安全HTML内容
	 */
	String clean(String html, XssType type);

	/**
	 * 验证HTML内容是否安全
	 * <p>
	 * 使用白名单策略验证HTML内容是否包含危险标签或属性
	 * </p>
	 * @param html 待验证的HTML内容
	 * @return true表示内容安全，false表示包含危险内容
	 */
	default boolean isValid(String html) {
		return Jsoup.isValid(html, XssUtil.WHITE_LIST);
	}

}
